FHIR Server FHIR Server Version n/a

Resource CapabilityStatement/FHIR Server from package ihe.iti.scheduling#current (110 ms)

Package

ihe.iti.scheduling

Type

CapabilityStatement

FHIR Version

Source

https://profiles.ihe.net/ITI/Scheduling/https://build.fhir.org/ig/IHE/ITI.Scheduling/CapabilityStatement-IHE.Scheduling.server.html

Url

https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server

Version

1.0.0-current

Status

active

Date

2024-02-05

Name

IHE_Scheduling_Server

Title

IHE Scheduling Server

Experimental

False

Realm

Authority

ihe

Description

CapabilityStatement for Server Actor in the IHE IT Infrastructure Technical Framework Supplement IHE FHIR Scheduling. See https://profiles.ihe.net/ITI/TF/Volume1/ch-38.html.

IHE http://www.ihe.net/Governance/#Intellectual_Property

Kind

requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide

https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp

Basic Audit Log Patterns (BALP)

http://hl7.org/fhir/uv/ipa/ImplementationGuide/hl7.fhir.uv.ipa

International Patient Access

http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch

SMART App Launch

https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book

Book_Appointment_Operation

https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find

Find_Appointments_Operation

https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-hold

Hold_Appointment_Operation

https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt

IHE ITI Appointment Profile

https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle

IHE ITI Scheduling Bundle Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient

IPA-Patient

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement IHE.Scheduling.server

IHE Scheduling Server

Implementation Guide Version: 1.0.0-current
FHIR Version: 4.0.1
Supported Formats: SHALL support application/fhir+xml, SHALL support application/fhir+json
Supported Patch Formats:
Published on: 2024-02-05
Published by: IHE IT Infrastructure Technical Committee

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHOULD Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: `server`

FooBar server provides capability to query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters

Security

None mandated by IHE, encouraged IHE-IUA or SMART-on-FHIR

Summary of System-wide Interactions

Supports the search-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	S	Searches	Operations
Appointment	https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt	y	y	_id, identifier, patient, date, specialty, appointment-type, practitioner, patient+date	`$find`, `$book`, `$hold`
Bundle	https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle
Patient	http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient	y	y	_id, idenitfier, birthdate, family, gender, given, name, family+gender, birthdate+family, birthdate+name, gender+name

Resource Conformance: SHALL Appointment

Base System Profile
https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Logical id of this artifact
SHALL	identifier	`token`	The client SHALL provide both the system and code values.
SHALL	patient	`reference`	The patient, or one of the patients, for whom this apointement exists
SHOULD	date	`date`	The date, or date range, for the appointments being searched.
SHOULD	specialty	`token`	The specialty for which the appointments being searched is.
SHOULD	appointment-type	`token`
SHOULD	practitioner	`reference`	The provider, or one of the providers, with whom this apointement is scheduled

Combined Search Parameters

Conformance	Parameters	Types
SHALL	patient+date	`reference`+`date`

Extended Operations

Conformance	Operation	Documentation
SHALL	$find	Document the find operation
SHALL	$book	Document the book operation
SHOULD	$hold	Document the hold operation

Resource Conformance: SHALL Bundle

Base System Profile
https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle

Profile Conformance
SHALL

Reference Policy

Interaction summary

Resource Conformance: SHALL Patient

Base System Profile
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Logical id of this artifact
SHALL	idenitfier	`token`	The server SHALL NOT support only code values.
SHOULD	birthdate	`date`	A server SHALL support a value precise to the day.
SHOULD	family	`string`	A portion of the family name of the patient
SHOULD	gender	`token`	Gender of the patient
SHOULD	given	`string`	A portion of the given name of the patient
SHOULD	name	`string`	The full name of the patient or part of it

Combined Search Parameters

Conformance	Parameters	Types
SHOULD	family+gender	`string`+`token`
SHOULD	birthdate+family	`date`+`string`
SHOULD	birthdate+name	`date`+`string`
SHOULD	gender+name	`token`+`string`

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "IHE.Scheduling.server",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement IHE.Scheduling.server</b></p><a name=\"IHE.Scheduling.server\"> </a><a name=\"hcIHE.Scheduling.server\"> </a><a name=\"IHE.Scheduling.server-en-US\"> </a><h2 id=\"title\">IHE Scheduling Server</h2><ul><li>Implementation Guide Version: 1.0.0-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <strong>SHALL</strong> support <code>application/fhir+xml</code>, <strong>SHALL</strong> support <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-02-05 </li><li>Published by: IHE IT Infrastructure Technical Committee </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shouldIGs\">SHOULD Support the Following Implementation Guides</h3><ul><li><a href=\"http://hl7.org/fhir/smart-app-launch/STU2/ImplementationGuide-hl7.fhir.uv.smart-app-launch.html\">http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch</a></li><li><a href=\"http://hl7.org/fhir/uv/ipa/STU1/ImplementationGuide-hl7.fhir.uv.ipa.html\">http://hl7.org/fhir/uv/ipa/ImplementationGuide/hl7.fhir.uv.ipa</a></li><li><a href=\"https://profiles.ihe.net/ITI/BALP/1.1.3/ImplementationGuide-ihe.iti.balp.html\">https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>FooBar server provides capability to query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>None mandated by IHE, encouraged IHE-IUA or SMART-on-FHIR</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Appointment1-1\">Appointment</a></td><td><a href=\"StructureDefinition-ihe-sched-appt.html\">https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, identifier, patient, date, specialty, appointment-type, practitioner, patient+date</td><td/><td/><td><code>$find</code>, <code>$book</code>, <code>$hold</code></td></tr><tr><td><a href=\"#Bundle1-2\">Bundle</a></td><td><a href=\"StructureDefinition-ihe-sched-avail-bundle.html\">https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Patient1-3\">Patient</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/STU1/StructureDefinition-ipa-patient.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, idenitfier, birthdate, family, gender, given, name, family+gender, birthdate+family, birthdate+name, gender+name</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Appointment1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Appointment</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ihe-sched-appt.html\">https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>The client <strong>SHALL</strong> provide both the system and code values.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient, or one of the patients, for whom this apointement exists</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">date</a></td><td><code>date</code></td><td><div><p>The date, or date range, for the appointments being searched.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">specialty</a></td><td><code>token</code></td><td><div><p>The specialty for which the appointments being searched is.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">appointment-type</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">practitioner</a></td><td><code>reference</code></td><td><div><p>The provider, or one of the providers, with whom this apointement is scheduled</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/appointment.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/appointment.html#search\">date</a></td><td><code>reference</code>+<code>date</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-appointment-find.html\">$find</a></td><td><div><p>Document the find operation</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-appointment-book.html\">$book</a></td><td><div><p>Document the book operation</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"OperationDefinition-appointment-hold.html\">$hold</a></td><td><div><p>Document the hold operation</p>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Bundle1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Bundle</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ihe-sched-avail-bundle.html\">https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul/></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/uv/ipa/STU1/StructureDefinition-ipa-patient.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">idenitfier</a></td><td><code>token</code></td><td><div><p>The server <em>SHALL NOT</em> support only code values.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">birthdate</a></td><td><code>date</code></td><td><div><p>A server <strong>SHALL</strong> support a value precise to the <em>day</em>.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">family</a></td><td><code>string</code></td><td><div><p>A portion of the family name of the patient</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">gender</a></td><td><code>token</code></td><td><div><p>Gender of the patient</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">given</a></td><td><code>string</code></td><td><div><p>A portion of the given name of the patient</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">name</a></td><td><code>string</code></td><td><div><p>The full name of the patient or part of it</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">family</a>+<a href=\"http://hl7.org/fhir/R4/patient.html#search\">gender</a></td><td><code>string</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">birthdate</a>+<a href=\"http://hl7.org/fhir/R4/patient.html#search\">family</a></td><td><code>date</code>+<code>string</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">birthdate</a>+<a href=\"http://hl7.org/fhir/R4/patient.html#search\">name</a></td><td><code>date</code>+<code>string</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">gender</a>+<a href=\"http://hl7.org/fhir/R4/patient.html#search\">name</a></td><td><code>token</code>+<code>string</code></td></tr></tbody></table></div></div></div></div></div></div>"
  },
  "url" : "https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server",
  "version" : "1.0.0-current",
  "name" : "IHE_Scheduling_Server",
  "title" : "IHE Scheduling Server",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-02-05",
  "publisher" : "IHE IT Infrastructure Technical Committee",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    },
    {
      "name" : "IHE IT Infrastructure Technical Committee",
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    }
  ],
  "description" : "CapabilityStatement for Server Actor in the IHE IT Infrastructure Technical Framework Supplement IHE FHIR Scheduling. See https://profiles.ihe.net/ITI/TF/Volume1/ch-38.html.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "copyright" : "IHE http://www.ihe.net/Governance/#Intellectual_Property",
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "_format" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }
      ]
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }
      ]
    }
  ],
  "implementationGuide" : [
    "http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch",
    "http://hl7.org/fhir/uv/ipa/ImplementationGuide/hl7.fhir.uv.ipa",
    "https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp"
  ],
  "_implementationGuide" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHOULD"
        }
      ]
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHOULD"
        }
      ]
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHOULD"
        }
      ]
    }
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "FooBar server provides capability to query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters",
      "security" : {
        "cors" : false,
        "description" : "None mandated by IHE, encouraged IHE-IUA or SMART-on-FHIR"
      },
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "date"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "Appointment",
          "profile" : "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token",
              "documentation" : "Logical id of this artifact"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type" : "token",
              "documentation" : "The client **SHALL** provide both the system and code values."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/Appointment-patient",
              "type" : "reference",
              "documentation" : "The patient, or one of the patients, for whom this apointement exists"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "date",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type" : "date",
              "documentation" : "The date, or date range, for the appointments being searched."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "specialty",
              "definition" : "http://hl7.org/fhir/SearchParameter/Appointment-specialty",
              "type" : "token",
              "documentation" : "The specialty for which the appointments being searched is."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "appointment-type",
              "definition" : "http://hl7.org/fhir/SearchParameter/Appointment-appointment-type",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "practitioner",
              "definition" : "http://hl7.org/fhir/SearchParameter/Appointment-practitioner",
              "type" : "reference",
              "documentation" : "The provider, or one of the providers, with whom this apointement is scheduled"
            }
          ],
          "operation" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "find",
              "definition" : "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find",
              "documentation" : "Document the find operation"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "book",
              "definition" : "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book",
              "documentation" : "Document the book operation"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "hold",
              "definition" : "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-hold",
              "documentation" : "Document the hold operation"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Bundle",
          "profile" : "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          }
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "family"
                },
                {
                  "url" : "required",
                  "valueString" : "gender"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "birthdate"
                },
                {
                  "url" : "required",
                  "valueString" : "family"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "birthdate"
                },
                {
                  "url" : "required",
                  "valueString" : "name"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "gender"
                },
                {
                  "url" : "required",
                  "valueString" : "name"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "Patient",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token",
              "documentation" : "Logical id of this artifact"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "idenitfier",
              "definition" : "http://hl7.org/fhir/SearchParameter/Patient-identifier",
              "type" : "token",
              "documentation" : "The server *SHALL NOT* support only code values."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "birthdate",
              "definition" : "http://hl7.org/fhir/SearchParameter/individual-birthdate",
              "type" : "date",
              "documentation" : "A server **SHALL** support a value precise to the *day*."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "family",
              "definition" : "http://hl7.org/fhir/SearchParameter/individual-family",
              "type" : "string",
              "documentation" : "A portion of the family name of the patient"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "gender",
              "definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
              "type" : "token",
              "documentation" : "Gender of the patient"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "given",
              "definition" : "http://hl7.org/fhir/SearchParameter/individual-given",
              "type" : "string",
              "documentation" : "A portion of the given name of the patient"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/SearchParameter/Patient-name",
              "type" : "string",
              "documentation" : "The full name of the patient or part of it"
            }
          ]
        }
      ],
      "interaction" : [
        {
          "code" : "search-system"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.

Resource CapabilityStatement/FHIR Server from package ihe.iti.scheduling#current (110 ms)

Resources that use this resource

Resources that this resource uses

Narrative

IHE Scheduling Server

SHOULD Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Appointment

Resource Conformance: SHALL Bundle

Resource Conformance: SHALL Patient

Source

Mode: `server`